package com.example.dormmanage.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

/**
 * swagger文档配置类
 */
@Component
// 开启Swagger2的自动配置
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {
    // 配置docket以配置Swagger具体参数
    @Bean
    //一个docket代表一个模块
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .select()//开始配置要生成那些接口文档
                .apis(RequestHandlerSelectors.basePackage("com.example.dormmanage.controller"))
                .build()
                .groupName("学生宿舍管理系统");
    }
    /**
     * 基本信息
     * @return
     */
    @Bean
    private ApiInfo apiInfo() {
        Contact contact = new Contact("涂煜峰", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
        return new ApiInfo("学生宿舍管理系统", // 标题
                "可以更加快捷的管理宿舍", // 描述
                "v1.0", // 版本
                "http://terms.service.url/组织链接", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()); // 扩展
    }
}

